---
layout: m1x_rest
title: Sales Orders
---


<ul class="introduction-menu">
    <li><a href='#RESTAPI-Resource-SalesOrders-RESTAPI-SalesOrders'>REST API: Sales Orders</a>
    <ul>
        <li><a href='#RESTAPI-Resource-SalesOrders-URI--orders'>URI: /orders</a>
        <ul>
            <li><a href='#RESTAPI-Resource-SalesOrders-HTTPMethod-GET-orders'>HTTP Method: GET /orders</a></li>
            <li><a href='#RESTAPI-Resource-SalesOrders-HTTPMethod-POST-orders'>HTTP Method: POST /orders</a></li>
            <li><a href='#RESTAPI-Resource-SalesOrders-HTTPMethod-PUT-orders'>HTTP Method: PUT /orders</a></li>
            <li><a href='#RESTAPI-Resource-SalesOrders-HTTPMethod-DELETE-orders'>HTTP Method: DELETE /orders</a></li>
        </ul>
        </li>
    </ul>
    </li>
    <li><a href='#RESTAPI-Resource-SalesOrders-RESTAPI-SalesOrder'>REST API: Sales Order</a>
    <ul>
        <li><a href='#RESTAPI-Resource-SalesOrders-URI--orders--id'>URI: /orders/:id</a>
        <ul>
            <li><a href='#RESTAPI-Resource-SalesOrders-HTTPMethod-GET-orders--id'>HTTP Method: GET /orders/:id</a></li>
            <li><a href='#RESTAPI-Resource-SalesOrders-HTTPMethod-POST-orders--id'>HTTP Method: POST /orders/:id</a></li>
            <li><a href='#RESTAPI-Resource-SalesOrders-HTTPMethod-PUT-orders--id'>HTTP Method: PUT /orders/:id</a></li>
            <li><a href='#RESTAPI-Resource-SalesOrders-HTTPMethod-DELETE-orders--id'>HTTP Method: DELETE /orders/:id</a></li>
        </ul>
        </li>
    </ul>
    </li>
</ul>

<h3><a name="RESTAPI-Resource-SalesOrders-RESTAPI-SalesOrders"></a>REST API: Sales Orders</h3>

<h4><a name="RESTAPI-Resource-SalesOrders-URI--orders"></a>URI: /orders</h4>

<p>Allows you to retrieve information on existing order/orders.</p>

<p><b>URL Structure</b>: http://magentohost/api/rest/orders<br/>
<b>Version</b>: 1</p>

<h5><a name="RESTAPI-Resource-SalesOrders-HTTPMethod-GET-orders"></a>HTTP Method: GET /orders</h5>

<p><b>Description</b>: Allows you to retrieve the list of existing orders. Each order contains the following information: general order information, information on ordered items, order comments, and order addresses (both billing and shipping).<br/>
The list of attributes that will be returned for the order is configured in the Magento Admin Panel.</p>

<p><b>Authentication</b>: Admin, Customer, Guest<br/>
<b>Default Format</b>: XML</p>

<p><b>Response Example: XML</b></p>

<div class='panelMacro'><table class='infoMacro'><tr><td>GET http://magentohost/api/rest/orders</td></tr></table></div>

<div class="panel" style="border-width: 1px;"><div class="panelContent">
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: java; gutter: false">&lt;?xml version="1.0"?&gt;
&lt;magento_api&gt;
  &lt;data_item_1&gt;
    &lt;customer_id&gt;3&lt;/customer_id&gt;
    &lt;base_discount_amount&gt;0.0000&lt;/base_discount_amount&gt;
    &lt;base_shipping_amount&gt;455.0000&lt;/base_shipping_amount&gt;
    &lt;base_shipping_tax_amount&gt;0.0000&lt;/base_shipping_tax_amount&gt;
    &lt;base_subtotal&gt;13650.0000&lt;/base_subtotal&gt;
    &lt;base_tax_amount&gt;0.0000&lt;/base_tax_amount&gt;
    &lt;base_total_paid&gt;&lt;/base_total_paid&gt;
    &lt;base_total_refunded&gt;&lt;/base_total_refunded&gt;
    &lt;tax_amount&gt;0.0000&lt;/tax_amount&gt;
    &lt;total_paid&gt;&lt;/total_paid&gt;
    &lt;total_refunded&gt;&lt;/total_refunded&gt;
    &lt;base_shipping_discount_amount&gt;0.0000&lt;/base_shipping_discount_amount&gt;
    &lt;base_subtotal_incl_tax&gt;13650.0000&lt;/base_subtotal_incl_tax&gt;
    &lt;base_total_due&gt;14105.0000&lt;/base_total_due&gt;
    &lt;total_due&gt;14105.0000&lt;/total_due&gt;
    &lt;base_currency_code&gt;USD&lt;/base_currency_code&gt;
    &lt;tax_name&gt;&lt;/tax_name&gt;
    &lt;tax_rate&gt;&lt;/tax_rate&gt;
    &lt;addresses&gt;
      &lt;data_item&gt;
        &lt;region&gt;Palau&lt;/region&gt;
        &lt;postcode&gt;19103&lt;/postcode&gt;
        &lt;lastname&gt;Doe&lt;/lastname&gt;
        &lt;street&gt;2356 Jody Road Philadelphia, PA 19103&lt;/street&gt;
        &lt;city&gt;PA&lt;/city&gt;
        &lt;telephone&gt;610-634-1181&lt;/telephone&gt;
        &lt;country_id&gt;US&lt;/country_id&gt;
        &lt;firstname&gt;John&lt;/firstname&gt;
        &lt;address_type&gt;billing&lt;/address_type&gt;
        &lt;prefix&gt;&lt;/prefix&gt;
        &lt;middlename&gt;&lt;/middlename&gt;
        &lt;suffix&gt;&lt;/suffix&gt;
        &lt;company&gt;&lt;/company&gt;
      &lt;/data_item&gt;
      &lt;data_item&gt;
        &lt;region&gt;Palau&lt;/region&gt;
        &lt;postcode&gt;19103&lt;/postcode&gt;
        &lt;lastname&gt;Doe&lt;/lastname&gt;
        &lt;street&gt;2356 Jody Road Philadelphia, PA 19103&lt;/street&gt;
        &lt;city&gt;PA&lt;/city&gt;
        &lt;telephone&gt;610-634-1181&lt;/telephone&gt;
        &lt;country_id&gt;US&lt;/country_id&gt;
        &lt;firstname&gt;John&lt;/firstname&gt;
        &lt;address_type&gt;shipping&lt;/address_type&gt;
        &lt;prefix&gt;&lt;/prefix&gt;
        &lt;middlename&gt;&lt;/middlename&gt;
        &lt;suffix&gt;&lt;/suffix&gt;
        &lt;company&gt;&lt;/company&gt;
      &lt;/data_item&gt;
    &lt;/addresses&gt;
    &lt;order_items&gt;
      &lt;data_item&gt;
        &lt;sku&gt;Sunglasses_1&lt;/sku&gt;
        &lt;price&gt;150.0000&lt;/price&gt;
        &lt;base_price&gt;150.0000&lt;/base_price&gt;
        &lt;base_original_price&gt;150.0000&lt;/base_original_price&gt;
        &lt;tax_percent&gt;0.0000&lt;/tax_percent&gt;
        &lt;tax_amount&gt;0.0000&lt;/tax_amount&gt;
        &lt;base_tax_amount&gt;0.0000&lt;/base_tax_amount&gt;
        &lt;base_discount_amount&gt;0.0000&lt;/base_discount_amount&gt;
        &lt;base_row_total&gt;13650.0000&lt;/base_row_total&gt;
        &lt;base_price_incl_tax&gt;150.0000&lt;/base_price_incl_tax&gt;
        &lt;base_row_total_incl_tax&gt;13650.0000&lt;/base_row_total_incl_tax&gt;
      &lt;/data_item&gt;
    &lt;/order_items&gt;
  &lt;/data_item_1&gt;
  &lt;data_item_2&gt;
    &lt;customer_id&gt;3&lt;/customer_id&gt;
    &lt;base_discount_amount&gt;0.0000&lt;/base_discount_amount&gt;
    &lt;base_shipping_amount&gt;95.0000&lt;/base_shipping_amount&gt;
    &lt;base_shipping_tax_amount&gt;0.0000&lt;/base_shipping_tax_amount&gt;
    &lt;base_subtotal&gt;3350.0000&lt;/base_subtotal&gt;
    &lt;base_tax_amount&gt;0.0000&lt;/base_tax_amount&gt;
    &lt;base_total_paid&gt;2445.0000&lt;/base_total_paid&gt;
    &lt;base_total_refunded&gt;1845.0000&lt;/base_total_refunded&gt;
    &lt;tax_amount&gt;0.0000&lt;/tax_amount&gt;
    &lt;total_paid&gt;2445.0000&lt;/total_paid&gt;
    &lt;total_refunded&gt;1845.0000&lt;/total_refunded&gt;
    &lt;base_shipping_discount_amount&gt;0.0000&lt;/base_shipping_discount_amount&gt;
    &lt;base_subtotal_incl_tax&gt;3350.0000&lt;/base_subtotal_incl_tax&gt;
    &lt;base_total_due&gt;1000.0000&lt;/base_total_due&gt;
    &lt;total_due&gt;1000.0000&lt;/total_due&gt;
    &lt;base_currency_code&gt;USD&lt;/base_currency_code&gt;
    &lt;tax_name&gt;&lt;/tax_name&gt;
    &lt;tax_rate&gt;&lt;/tax_rate&gt;
    &lt;addresses&gt;
      &lt;data_item&gt;
        &lt;region&gt;Palau&lt;/region&gt;
        &lt;postcode&gt;19103&lt;/postcode&gt;
        &lt;lastname&gt;Doe&lt;/lastname&gt;
        &lt;street&gt;2356 Jody Road Philadelphia, PA 19103&lt;/street&gt;
        &lt;city&gt;PA&lt;/city&gt;
        &lt;telephone&gt;610-634-1181&lt;/telephone&gt;
        &lt;country_id&gt;US&lt;/country_id&gt;
        &lt;firstname&gt;John&lt;/firstname&gt;
        &lt;address_type&gt;billing&lt;/address_type&gt;
        &lt;prefix&gt;&lt;/prefix&gt;
        &lt;middlename&gt;&lt;/middlename&gt;
        &lt;suffix&gt;&lt;/suffix&gt;
        &lt;company&gt;&lt;/company&gt;
      &lt;/data_item&gt;
      &lt;data_item&gt;
        &lt;region&gt;Palau&lt;/region&gt;
        &lt;postcode&gt;19103&lt;/postcode&gt;
        &lt;lastname&gt;Doe&lt;/lastname&gt;
        &lt;street&gt;2356 Jody Road Philadelphia, PA 19103&lt;/street&gt;
        &lt;city&gt;PA&lt;/city&gt;
        &lt;telephone&gt;610-634-1181&lt;/telephone&gt;
        &lt;country_id&gt;US&lt;/country_id&gt;
        &lt;firstname&gt;John&lt;/firstname&gt;
        &lt;address_type&gt;shipping&lt;/address_type&gt;
        &lt;prefix&gt;&lt;/prefix&gt;
        &lt;middlename&gt;&lt;/middlename&gt;
        &lt;suffix&gt;&lt;/suffix&gt;
        &lt;company&gt;&lt;/company&gt;
      &lt;/data_item&gt;
    &lt;/addresses&gt;
    &lt;order_items&gt;
      &lt;data_item&gt;
        &lt;sku&gt;Sunglasses_1&lt;/sku&gt;
        &lt;price&gt;150.0000&lt;/price&gt;
        &lt;base_price&gt;150.0000&lt;/base_price&gt;
        &lt;base_original_price&gt;150.0000&lt;/base_original_price&gt;
        &lt;tax_percent&gt;0.0000&lt;/tax_percent&gt;
        &lt;tax_amount&gt;0.0000&lt;/tax_amount&gt;
        &lt;base_tax_amount&gt;0.0000&lt;/base_tax_amount&gt;
        &lt;base_discount_amount&gt;0.0000&lt;/base_discount_amount&gt;
        &lt;base_row_total&gt;1350.0000&lt;/base_row_total&gt;
        &lt;base_price_incl_tax&gt;150.0000&lt;/base_price_incl_tax&gt;
        &lt;base_row_total_incl_tax&gt;1350.0000&lt;/base_row_total_incl_tax&gt;
      &lt;/data_item&gt;
      &lt;data_item&gt;
        &lt;sku&gt;Sun_glasses&lt;/sku&gt;
        &lt;price&gt;200.0000&lt;/price&gt;
        &lt;base_price&gt;200.0000&lt;/base_price&gt;
        &lt;base_original_price&gt;200.0000&lt;/base_original_price&gt;
        &lt;tax_percent&gt;0.0000&lt;/tax_percent&gt;
        &lt;tax_amount&gt;0.0000&lt;/tax_amount&gt;
        &lt;base_tax_amount&gt;0.0000&lt;/base_tax_amount&gt;
        &lt;base_discount_amount&gt;0.0000&lt;/base_discount_amount&gt;
        &lt;base_row_total&gt;2000.0000&lt;/base_row_total&gt;
        &lt;base_price_incl_tax&gt;200.0000&lt;/base_price_incl_tax&gt;
        &lt;base_row_total_incl_tax&gt;2000.0000&lt;/base_row_total_incl_tax&gt;
      &lt;/data_item&gt;
    &lt;/order_items&gt;
  &lt;/data_item_2&gt;
&lt;/magento_api&gt;</pre>
		</div>
</div></div>
</div></div>


<h5><a name="RESTAPI-Resource-SalesOrders-HTTPMethod-POST-orders"></a>HTTP Method: POST /orders</h5>

<p><b>Description</b>: Not implemented.</p>


<h5><a name="RESTAPI-Resource-SalesOrders-HTTPMethod-PUT-orders"></a>HTTP Method: PUT /orders</h5>

<p><b>Description</b>: Not implemented.</p>


<h5><a name="RESTAPI-Resource-SalesOrders-HTTPMethod-DELETE-orders"></a>HTTP Method: DELETE /orders</h5>

<p><b>Description</b>: Not implemented.</p>

<h3><a name="RESTAPI-Resource-SalesOrders-RESTAPI-SalesOrder"></a>REST API: Sales Order</h3>

<h4><a name="RESTAPI-Resource-SalesOrders-URI--orders--id"></a>URI: /orders/:id</h4>

<p>Allows you to retrieve information on a single order.<br/>
The list of attributes that will be returned for the order is configured in the Magento Admin Panel.</p>

<p><b>URL Structure</b>: http://magentohost/api/rest/orders/:id<br/>
<b>Version</b>: 1</p>

<h5><a name="RESTAPI-Resource-SalesOrders-HTTPMethod-GET-orders--id"></a>HTTP Method: GET /orders/:id</h5>

<p><b>Description</b>: Allows you to retrieve the order information.<br/>
<b>Authentication</b>: Admin, Customer<br/>
<b>Default Format</b>: XML</p>

<p><b>Response Example: XML</b></p>

<div class='panelMacro'><table class='infoMacro'><tr><td>GET http://magentohost/api/rest/orders/32</td></tr></table></div>

<div class="panel" style="border-width: 1px;"><div class="panelContent">
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: java; gutter: false">&lt;?xml version="1.0"?&gt;
&lt;magento_api&gt;
  &lt;customer_id&gt;3&lt;/customer_id&gt;
  &lt;base_discount_amount&gt;0.0000&lt;/base_discount_amount&gt;
  &lt;base_shipping_amount&gt;0.0000&lt;/base_shipping_amount&gt;
  &lt;base_shipping_tax_amount&gt;0.0000&lt;/base_shipping_tax_amount&gt;
  &lt;base_subtotal&gt;5220.0000&lt;/base_subtotal&gt;
  &lt;base_tax_amount&gt;430.6500&lt;/base_tax_amount&gt;
  &lt;base_total_paid&gt;&lt;/base_total_paid&gt;
  &lt;base_total_refunded&gt;&lt;/base_total_refunded&gt;
  &lt;tax_amount&gt;304.3300&lt;/tax_amount&gt;
  &lt;total_paid&gt;&lt;/total_paid&gt;
  &lt;total_refunded&gt;&lt;/total_refunded&gt;
  &lt;base_shipping_discount_amount&gt;0.0000&lt;/base_shipping_discount_amount&gt;
  &lt;base_subtotal_incl_tax&gt;&lt;/base_subtotal_incl_tax&gt;
  &lt;base_total_due&gt;&lt;/base_total_due&gt;
  &lt;total_due&gt;&lt;/total_due&gt;
  &lt;base_currency_code&gt;USD&lt;/base_currency_code&gt;
  &lt;tax_name&gt;US-CA-*-Rate 1&lt;/tax_name&gt;
  &lt;tax_rate&gt;8.2500&lt;/tax_rate&gt;
  &lt;addresses&gt;
    &lt;data_item&gt;
      &lt;region&gt;Palau&lt;/region&gt;
      &lt;postcode&gt;19103&lt;/postcode&gt;
      &lt;lastname&gt;Doe&lt;/lastname&gt;
      &lt;street&gt;2356 Jody Road Philadelphia
844 Jefferson Street; 4510 Willis Avenue&lt;/street&gt;
      &lt;city&gt;PA&lt;/city&gt;
      &lt;telephone&gt;610-634-1181&lt;/telephone&gt;
      &lt;country_id&gt;US&lt;/country_id&gt;
      &lt;firstname&gt;John&lt;/firstname&gt;
      &lt;address_type&gt;billing&lt;/address_type&gt;
      &lt;prefix&gt;Dr.&lt;/prefix&gt;
      &lt;middlename&gt;&lt;/middlename&gt;
      &lt;suffix&gt;Jr.&lt;/suffix&gt;
      &lt;company&gt;&lt;/company&gt;
    &lt;/data_item&gt;
    &lt;data_item&gt;
      &lt;region&gt;Palau&lt;/region&gt;
      &lt;postcode&gt;19103&lt;/postcode&gt;
      &lt;lastname&gt;Doe&lt;/lastname&gt;
      &lt;street&gt;2356 Jody Road Philadelphia
844 Jefferson Street; 4510 Willis Avenue&lt;/street&gt;
      &lt;city&gt;PA&lt;/city&gt;
      &lt;telephone&gt;610-634-1181&lt;/telephone&gt;
      &lt;country_id&gt;US&lt;/country_id&gt;
      &lt;firstname&gt;John&lt;/firstname&gt;
      &lt;address_type&gt;shipping&lt;/address_type&gt;
      &lt;prefix&gt;Dr.&lt;/prefix&gt;
      &lt;middlename&gt;&lt;/middlename&gt;
      &lt;suffix&gt;Jr.&lt;/suffix&gt;
      &lt;company&gt;&lt;/company&gt;
    &lt;/data_item&gt;
  &lt;/addresses&gt;
  &lt;order_items&gt;
    &lt;data_item&gt;
      &lt;sku&gt;Sun_glasses&lt;/sku&gt;
      &lt;price&gt;141.3400&lt;/price&gt;
      &lt;base_price&gt;200.0000&lt;/base_price&gt;
      &lt;base_original_price&gt;200.0000&lt;/base_original_price&gt;
      &lt;tax_percent&gt;8.2500&lt;/tax_percent&gt;
      &lt;tax_amount&gt;11.6600&lt;/tax_amount&gt;
      &lt;base_tax_amount&gt;16.5000&lt;/base_tax_amount&gt;
      &lt;base_discount_amount&gt;0.0000&lt;/base_discount_amount&gt;
      &lt;base_row_total&gt;200.0000&lt;/base_row_total&gt;
      &lt;base_price_incl_tax&gt;216.5000&lt;/base_price_incl_tax&gt;
      &lt;base_row_total_incl_tax&gt;216.5000&lt;/base_row_total_incl_tax&gt;
    &lt;/data_item&gt;
    &lt;data_item&gt;
      &lt;sku&gt;Virtual_product&lt;/sku&gt;
      &lt;price&gt;14.1340&lt;/price&gt;
      &lt;base_price&gt;20.0000&lt;/base_price&gt;
      &lt;base_original_price&gt;20.0000&lt;/base_original_price&gt;
      &lt;tax_percent&gt;8.2500&lt;/tax_percent&gt;
      &lt;tax_amount&gt;1.1700&lt;/tax_amount&gt;
      &lt;base_tax_amount&gt;1.6500&lt;/base_tax_amount&gt;
      &lt;base_discount_amount&gt;0.0000&lt;/base_discount_amount&gt;
      &lt;base_row_total&gt;20.0000&lt;/base_row_total&gt;
      &lt;base_price_incl_tax&gt;21.6500&lt;/base_price_incl_tax&gt;
      &lt;base_row_total_incl_tax&gt;21.6500&lt;/base_row_total_incl_tax&gt;
    &lt;/data_item&gt;
    &lt;data_item&gt;
      &lt;sku&gt;test_simple_product&lt;/sku&gt;
      &lt;price&gt;353.3500&lt;/price&gt;
      &lt;base_price&gt;500.0000&lt;/base_price&gt;
      &lt;base_original_price&gt;500.0000&lt;/base_original_price&gt;
      &lt;tax_percent&gt;8.2500&lt;/tax_percent&gt;
      &lt;tax_amount&gt;291.5000&lt;/tax_amount&gt;
      &lt;base_tax_amount&gt;412.5000&lt;/base_tax_amount&gt;
      &lt;base_discount_amount&gt;0.0000&lt;/base_discount_amount&gt;
      &lt;base_row_total&gt;5000.0000&lt;/base_row_total&gt;
      &lt;base_price_incl_tax&gt;541.2500&lt;/base_price_incl_tax&gt;
      &lt;base_row_total_incl_tax&gt;5412.5000&lt;/base_row_total_incl_tax&gt;
    &lt;/data_item&gt;
  &lt;/order_items&gt;
&lt;/magento_api&gt;</pre>
		</div>
</div></div>
</div></div>


<h5><a name="RESTAPI-Resource-SalesOrders-HTTPMethod-POST-orders--id"></a>HTTP Method: POST /orders/:id</h5>

<p><b>Description</b>: Not implemented.</p>


<h5><a name="RESTAPI-Resource-SalesOrders-HTTPMethod-PUT-orders--id"></a>HTTP Method: PUT /orders/:id</h5>

<p><b>Description</b>: Not implemented.</p>


<h5><a name="RESTAPI-Resource-SalesOrders-HTTPMethod-DELETE-orders--id"></a>HTTP Method: DELETE /orders/:id</h5>

<p><b>Description</b>: Not implemented.</p>



		    
